Hello, @jlgeering! This is your first Pull Request that will be reviewed by Ebert, an automatic Code Review service. It will leave comments on this diff with potential issues and style violations found in the code as you push new commits. You can also see all the issues found on this Pull Request on its review page. Please check our documentation for more information.

There is nothing wrong with including a link to the CHANGELOG but we don't have this habit in our projects and, since we include the link to the source, the information can easily found. Thanks @jlgeering!

@josevalim you are correct, it is just 1 additional click, but it is an annoying one. Damn, why are habits so hard to change ;-)

But maybe there is a better / easier way that I don't know of, to got from the output of mix hex.outdated to the changelog of a package, without having to search for the package on hex.pm? Or would that be a feature request for hex?

@josevalim and would you also reject a PR to add the changelog as a page to the documentation (extra), like for example https://hexdocs.pm/quantum/changelog.html ?

PS or is there a way (a link) to go from https://hexdocs.pm/ex_doc/readme.html to github / the changelog?

@jlgeering also note that linking to master will definitely be wrong for most releases. Since pages are not per release, I don't think including the changelog there is a good idea. Including it as part of the docs is definitely a better option. We can try that! 👍

well I would tend to disagree on linking to master not being a good thing, as for example https://github.com/elixir-lang/ex_doc/blob/master/CHANGELOG.md actually contains all versions and so is appropriate for all releases ;-)

anyways, created a PR for plan B